A HyperLink is a link between CygNet Studio screens. HyperLinks are typically used for navigation or to reset the [SiteService] and [Facility] property values of the current view. For example, a HyperLink can take a user from a "Main Menu" screen to an "Alarms" screen.
The Standard Button can be configured as a HyperLink button. You can also perform HyperLinks using script.
A HyperLink has five main properties: SiteService, FacilityID, File Path, AutoClose, and NewViewGroup.
| Property | Description |
|---|---|
|
[HyperLink SiteService] |
The ID of the Site.Service to be set on the destination screen. If blank, the value specified by the [SiteService] property of the current screen will be passed. |
|
[HyperLink FacilityID] |
The ID of the FACILITY to be set on the destination screen. If blank, the value specified by the [Facility] property of the current screen will be passed. |
|
[FilePath] |
The file name (and path) of the screen to be opened. This property cannot be blank; however, it can be set to the file path of the current view. In such instances, the file is "restarted" with new Site.Service and Facility parameters. |
|
[AutoClose] |
Once the HyperLink is complete, the current view is closed. |
|
[NewViewGroup] |
Enables multiple copies of the same screen to be opened but with the property values set differently. |